# eric7.Plugins.PluginVcsMercurial

Module implementing the Mercurial version control plugin.

### Global Attributes

__header__
error
mercurialCfgPluginObject

### Classes

VcsMercurialPlugin | Class implementing the Mercurial version control plugin.

### Functions

clearPrivateData | Module function to clear the private data of the plug-in.
createConfigurationPage | Module function to create the configuration page.
displayString | Public function to get the display string.
exeDisplayData | Public method to support the display of some executable info.
getConfigData | Module function returning data as required by the configuration dialog.
getVcsSystemIndicator | Public function to get the indicators for this version control system.
prepareUninstall | Module function to prepare for an uninstallation.

## VcsMercurialPlugin

Class implementing the Mercurial version control plugin.

### Derived from

QObject

### Class Attributes

MercurialDefaults

### Class Methods

getPreferences | Class method to retrieve the various settings.
setPreferences | Class method to store the various settings.

### Methods

VcsMercurialPlugin | Constructor
activate | Public method to activate this plugin.
deactivate | Public method to deactivate this plugin.
getConfigPath | Public method to get the filename of the config file.
getGlobalOptions | Public method to build a list of global options.
getProjectHelper | Public method to get a reference to the project helper object.
initToolbar | Public slot to initialize the VCS toolbar.
prepareUninstall | Public method to prepare for an uninstallation.
prepareUnload | Public method to prepare for an unload.

### Static Methods

None

#### VcsMercurialPlugin.getPreferences (class method)

getPreferences(key)

Class method to retrieve the various settings.

key (str)
  the key of the value to get

Return:
  the requested setting

Return Type:
  Any

#### VcsMercurialPlugin.setPreferences (class method)

setPreferences(key, value)

Class method to store the various settings.

key (str)
  the key of the setting to be set
value (Any)
  the value to be set

#### VcsMercurialPlugin (Constructor)

VcsMercurialPlugin(ui)

Constructor

ui (UserInterface)
  reference to the user interface object

#### VcsMercurialPlugin.activate

activate()

Public method to activate this plugin.

Return:
  tuple of reference to instantiated viewmanager and activation status

Return Type:
  tuple of (Hg, bool)

#### VcsMercurialPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

#### VcsMercurialPlugin.getConfigPath

getConfigPath()

Public method to get the filename of the config file.

Return:
  filename of the config file

Return Type:
  str

#### VcsMercurialPlugin.getGlobalOptions

getGlobalOptions()

Public method to build a list of global options.

Return:
  list of global options

Return Type:
  list of str

#### VcsMercurialPlugin.getProjectHelper

getProjectHelper()

Public method to get a reference to the project helper object.

Return:
  reference to the project helper object

Return Type:
  HgProjectHelper

#### VcsMercurialPlugin.initToolbar

initToolbar(ui, toolbarManager)

Public slot to initialize the VCS toolbar.

ui (UserInterface)
  reference to the main window
toolbarManager (EricToolBarManager)
  reference to a toolbar manager object

#### VcsMercurialPlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

#### VcsMercurialPlugin.prepareUnload

prepareUnload()

Public method to prepare for an unload.

Up

## clearPrivateData

clearPrivateData()

Module function to clear the private data of the plug-in.

Up

## createConfigurationPage

createConfigurationPage(_configDlg)

Module function to create the configuration page.

_configDlg (QDialog)
  reference to the configuration dialog (unused)

Return:
  reference to the configuration page

Return Type:
  MercurialPage

Up

## displayString

displayString()

Public function to get the display string.

Return:
  display string

Return Type:
  str

Up

## exeDisplayData

exeDisplayData()

Public method to support the display of some executable info.

Return:
  dictionary containing the data to query the presence of the executable

Return Type:
  dict

Up

## getConfigData

getConfigData()

Module function returning data as required by the configuration dialog.

Return:
  dictionary with key "zzz_mercurialPage" containing the relevant data

Return Type:
  dict

Up

## getVcsSystemIndicator

getVcsSystemIndicator()

Public function to get the indicators for this version control system.

Return:
  dictionary with indicator as key and a tuple with the vcs name and vcs display string

Return Type:
  dict

Up

## prepareUninstall

prepareUninstall()

Module function to prepare for an uninstallation.

Up